add spell check to markdown files #239
Conversation
| install: | ||
| - npm i -g markdown-spellcheck | ||
| before_script: | ||
| - wget --quiet https://gist.githubusercontent.com/juancarlostong/dad02feeebc8763af35b4fdc717cf7a2/raw/29e085302a9418edbefba15d8f790fa76e0a89d5/.spelling |
There was a problem hiding this comment.
opting for a simple wget rather than the more expensive cloning of an entire repo. we only need this one file anyway and there's no secrets in it.
There was a problem hiding this comment.
Does it have to be node? Is there a more performant platform we can use?
Also, I'd prefer if we can run this in parallel to the other stages so we don't have to wait for it
There was a problem hiding this comment.
it runs in parallel within the 'Lint markdown files' stage. in practice:
here you can see it finishes in 39 seconds, which is faster than the other job that ran in parallel (43s) meaning that it does not add to the existing build time
|
if this PR looks good, i will create similar PRs on all the remaining SDK repos |
| install: | ||
| - npm i -g markdown-spellcheck | ||
| before_script: | ||
| - wget --quiet https://gist.githubusercontent.com/juancarlostong/dad02feeebc8763af35b4fdc717cf7a2/raw/29e085302a9418edbefba15d8f790fa76e0a89d5/.spelling |
There was a problem hiding this comment.
Does it have to be node? Is there a more performant platform we can use?
Also, I'd prefer if we can run this in parallel to the other stages so we don't have to wait for it
Summary
This is what it looks like when it finds a spelling error (aborts build):
https://travis-ci.org/optimizely/ruby-sdk/jobs/647067279